home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 027a / springb.zip / SB.DOC < prev    next >
Text File  |  1991-10-26  |  9KB  |  204 lines
  1. SpringBoard
  2. (c) Copyright 1991 SoundView Data Systems All Rights Reserved.
  3.  
  4. *----------------------------------
  5. Introduction
  6.  
  7. SpringBoard is a mini-compiler that generates tiny programs that can be
  8. used to paint a "Loading..." message on the user's screen, while loading
  9. and beginning execution of much larger applications. This helps to solve 
  10. the problem of "what to show the user while loading a large application 
  11. from a slow hard-disk or floppy".
  12.  
  13. SpringBoard supports a set of functions designed to permit the display 
  14. of attractive text-mode screens. These functions include Clear(), 
  15. Fill(), Sprint(), box-drawing and color-setting functions, and a Run() 
  16. function that loads and executes the target application.  SpringBoard 
  17. uses standard DOS text files as source code, and produces .COM type 
  18. output files. No external linking step is required.
  19.  
  20. The SpringBoard Run() function is specially designed to load the
  21. target program to begin at the same memory address that the launcher
  22. originally occupied; thus, the application sees NO LOSS of memory, as
  23. compared with it running manually from the DOS command line. The only
  24. overhead is the loading time for the launcher; these small .com
  25. type programs are typically approximately 5K in size, and load rapidly.
  26.  
  27.  
  28.  
  29.  
  30. *----------------------------------
  31. Operation
  32.  
  33. Use of the SpringBoard system is very simple. A source file should be
  34. written using any standard text editor. A sample file (TEST.SRC) is
  35. included to demonstrate the basic techniques used, and the
  36. language syntax is documented below. The SpringBoard compiler is
  37. executed with the command:
  38.  
  39.         SB <source>[extension]  <output>[extension]
  40.  
  41. The source file extension defaults to ".SRC" but any extension may be
  42. specified. The output file, however, will always be a ".COM" file,
  43. regardless of the extension passed.
  44.  
  45. The output file (the "launcher" file) can be executed with or without
  46. command-line arguments. If any are passed, they will be used rather than
  47. the target filespec and arguments that were originally specified in the
  48. source code.
  49.  
  50.  
  51. *----------------------------------
  52. Syntax
  53.  
  54. SpringBoard supports the following functions (all arguments are
  55. required - none are optional):
  56.  
  57.     CLEAR()
  58.     SPRINT( nRow, nCol, cTEXT )
  59.     SINGLEBOX( nTopLeftRow, nTopLeftCol, nBottomRightRow, nBottomRightCol )
  60.     DOUBLEBOX( nTopLeftRow, nTopLeftCol, nBottomRightRow, nBottomRightCol )
  61.     SETCOLOR( cColorString )
  62.     SETMONO( cColorString )
  63.     FILL( nTopLeftRow, nTopLeftCol, nBottomRightRow, nBottomRightCol, cChar )
  64.     RUN( cProgname [args] )
  65.  
  66.  
  67. CLEAR()
  68. This function is called with no argument, and will clear the screen,
  69. using the current color scheme, depending upon the video mode detected.
  70.  
  71.  
  72. SPRINT( nRow, nCol, cTEXT )
  73. This is the screen print function, and the mainstay of most
  74. applications. All character-type arguments should be passed in single-
  75. or double-quote delimited format. The Row and Column coordinates are
  76. numeric. Line-drawing and other high-ASCII characters can be included in
  77. the character string.
  78.  
  79.  
  80.  
  81. SINGLEBOX( nTopLeftRow, nTopLeftCol, nBottomRightRow, nBottomRightCol )
  82. DOUBLEBOX( nTopLeftRow, nTopLeftCol, nBottomRightRow, nBottomRightCol )
  83. Use these functions to draw single-line or double-line boxes on the
  84. screen, at the passed coordinates. Use a SETCOLOR() or SETMONO() command
  85. prior to calling these functions to produce boxes of attractive and
  86. contrasting color, since the functions themselves do not accept  color
  87. arguments.
  88.  
  89.  
  90.  
  91. SETCOLOR( cColorString )
  92. SETMONO( cColorString )
  93. The SpringBoard runtime package will determine whether a COLOR or MONO
  94. video mode is currently in effect, and will use the color attribute set
  95. by one of these functions. ColorString is a character-type argument,
  96. passed in single or double quotes, and accepts standard xBase color
  97. abbreviations. Please note, however, that the ColorString should
  98. evaluate to a single attribute, with the foreground value(s) seperated
  99. from the background by a slash("/") in typical xBase manner.
  100.  
  101.  
  102. FILL( nTopLeftRow, nTopLeftCol, nBottomRightRow, nBottomRightCol, cChar )
  103. This function will fill a specified rectangular area of the screen with
  104. the specified character. The color will be the current color, and should
  105. be set with SETCOLOR() and SETMONO() prior to calling FILL(). The fill
  106. character should be delimited with single or double quotes, and can be a
  107. high-ASCII graphic character.
  108.  
  109.  
  110. RUN( cProgname [args] )
  111. This is the heart of the SpringBoard system. The launch code will
  112. relocate itself to high-memory, load the target application at its own
  113. prior address, and then execute it. Thus the target application
  114. experiences no loss of RAM despite the size of the launch program. If
  115. the target file specification does not contain any path information, and
  116. a PATH environmental variable exists, the directories listed in that
  117. variable will then be searched for the target file. If no file extension
  118. is passed, ".exe" will be assumed. If the target is successfully
  119. executed, no additional code in the launcher beyond the RUN() function
  120. will be executed. If the RUN() function fails, additional code can be
  121. executed to inform the user of the failure. The SpringBoard launcher
  122. will echo the ErrorLevel returned by the failed DOS attempt to load the
  123. target file.
  124.  
  125.  
  126.  
  127.  
  128.  
  129. *----------------------------------
  130. Errors
  131.  
  132. You will be notified if there are DOS errors associated with
  133. locating and opening the input and output files, as well as if the
  134. filespecs are identical (which is not permitted).
  135.  
  136. If a syntax error is detected, such as a mis-spelled or unrecognized
  137. function name, the compile is aborted, and the error and line number
  138. are displayed on the STDERR device. However, there is minimal
  139. error-checking for the arguments passed to the functions, so please
  140. check your source carefully to avoid unexpected and potentially
  141. unpleasant results.
  142.  
  143.  
  144.  
  145. *----------------------------------
  146. Legal Stuff...
  147.  
  148.                    Copyright Notice and Software License
  149.  
  150. This  document; other accompanying written and disk-based notes and
  151. specifications; and all referenced and related program files, 
  152. demonstration code and object modules accompanying this document are 
  153. copyrighted by SoundView Data Systems. The copyright owner hereby 
  154. licenses you to: use the software; make as many copies of the software 
  155. and documentation as you wish; give exact copies of the original to 
  156. anyone; and distribute the software and documentation in its unmodified  
  157. form via electronic means. There is no charge for any of the above.
  158.  
  159. You are specifically prohibited from charging or requesting donations for
  160. any such copies, however made.  Exceptions may be granted to organizations
  161. which charge a small fee for materials, handling, postage and general
  162. overhead. NO ORGANIZATION IS AUTHORIZED TO CHARGE ANY AMOUNT FOR 
  163. DISTRIBUTION OF THE SOFTWARE OR DOCUMENTATION UNDER ANY OTHER 
  164. CONDITIONS.  Organizations which charge a fee for distribution of any 
  165. and all SpringBoard materials, except as noted above or with the 
  166. express, written consent of SoundView Data Systems, will be considered 
  167. in violation of this copyright and will be prosecuted to the full 
  168. extent of the law.
  169.  
  170. In addition, you are specifically prohibited from making any modifications
  171. to the archive file prior to redistribution.  This archive contains the
  172. following files:
  173.     SB.DOC       This file
  174.     SB.EXE       The SpringBoard executable
  175.     TEST.SRC     A sample program
  176.     PRODUCT.INF  Product information about other utilities from SoundView
  177.                  Data Systems and Programming Solutions, Inc.
  178.     SY.NG        Norton Guides Database for SEZ YOU and SEZ YOU Professional
  179.     PE.NG        Norton Guides Database for PS ERROR
  180.  
  181. If any of the above files are missing, contact SoundView Data Systems or
  182. Programming Solutions, Inc. immediatly (contact information is below).
  183.  
  184. No copy of the software may be distributed or given away without this
  185. accompanying documentation; this notice must not be removed.
  186.  
  187.  
  188.                                  Warranty
  189.  
  190. There is  no warranty  of any  kind associated  with this software, and the
  191. copyright owner  is not  liable for  damages of  any kind.   By  using this
  192. software, you  agree to  this.  Every effort has been made by SoundView 
  193. Data Systems to make this product bug-free. However, the nature of 
  194. software development is that it is impossible to guarantee bug-free 
  195. software.
  196.  
  197. If you do encounter a bug, however, please notify SoundView Data Systems 
  198. (CompuServe 72356,1063) or Programming Solutions, Inc. (CompuServe 73320,3117
  199. or telephone 801-262-4141) of the problem.
  200.  
  201. *---end of file
  202.  
  203.  
  204.